/*
 * yocef - Lightweight IoC Event Framework
 *
 * Copyright (c) 2009, Yves Cuillerdier
 * All rights reserved.
 * 
 * This software is licensed under the new BSD License:
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, 
 * this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice, 
 * this list of conditions and the following disclaimer in the documentation 
 * and/or other materials provided with the distribution.
 * 
 * Neither the name of the author nor the names of its contributors may 
 * be used to endorse or promote products derived from this software without 
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 * @version 0.8.2
 */

package yocef.client;

/**
 * EventAction represents the action to be executed in response of an
 * {@link Event} occurring on a <b>source</b> object. The couple
 * <code>{Event,Object}</code> is an {@link EventBind}. A given
 * {@link EventBind} could not have more than one action!
 * <p>
 * The same action could be set into many {@link EventBind}.
 * <p>
 * This class has to be extended to provided the necessary behavior.
 * 
 * @see Event
 * @see EventBind
 */
public interface EventAction {

	/**
	 * This method is called whenever a native event is thrown on the source
	 * object or when the {@link Event#fire(Object, EventParams)} method is
	 * called.
	 * 
	 * @param event
	 *            the trigger event
	 * @param source
	 *            the source element
	 * @param context
	 *            the context for the handler
	 * @param params
	 *            the events properties when it occurred
	 * @return boolean the meaning of the return value is Event type dependant.
	 *         Generally, <tt>true</tt> means "please go on" while
	 *         <tt>false</tt> meant for "stop processing".
	 */
	public abstract boolean handle(Event event, Object source,
			EventContext context, EventParams params);
}
